Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Connectors wave 1 #4794

Open
wants to merge 46 commits into
base: main
Choose a base branch
from
Open

Connectors wave 1 #4794

wants to merge 46 commits into from

Conversation

mesellings
Copy link
Contributor

@mesellings mesellings commented Dec 19, 2024

Description

This PR contains the first wave of the Connector docs enhancements (https://github.com/camunda/developer-experience/issues/356).

Preview: https://preview.docs.camunda.cloud/pr-4794/docs/next/components/connectors/introduction-to-connectors/

Changes can be summarised as follows:

  • Content is now structured into 3 areas, so clearer and quicker for users to find content.
  • Added a popular/new section to the landing page.
  • Added a banner at the bottom of main landing pages to cross-link to the marketplace.
  • On the main Connectors page layout changed to match the home page cards, and clickable badges added for connector type.
  • Added connector logos and used marketplace/product ones where possible, but some don't lend themselves well to our content (tiny text) so some are different.
  • Removed the "connector" suffix from the left-hand menu items.
  • Main connector landing pages had an initial overhaul (ahead of wave 3).
  • Started converting "Connector" to lower-case on landing pages as part of the Connector casing work.

Reviewers: This work basically gives us a restructured menu and improves the main connector landing pages.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@mesellings mesellings added kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) component:docs Documentation improvements, including new or updated content hold This issue is parked, do not merge. component:connectors Issues related to the connectors project. target:8.7 Issues included in the 8.7 release deploy Stand up a temporary docs site with this PR labels Dec 19, 2024
@mesellings mesellings self-assigned this Dec 19, 2024
Copy link
Contributor

github-actions bot commented Dec 19, 2024

👋 🤖 🤔 Hello, @mesellings! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

  • docs/components/connectors/connector-types.md
  • docs/components/connectors/custom-built-connectors/build-connector.md
  • docs/components/connectors/custom-built-connectors/connector-template-generator.md
  • docs/components/connectors/custom-built-connectors/img/diagram-connectors.png
  • docs/components/connectors/img/Untitled-1.png
  • docs/components/connectors/img/connector-365.png
  • docs/components/connectors/img/connector-amazon-bedrock.png
  • docs/components/connectors/img/connector-amazon-eventbridge.png
  • docs/components/connectors/img/connector-amazon-s3.png
  • docs/components/connectors/img/connector-amazon-sns.png
  • docs/components/connectors/img/connector-amazon-sqs.png
  • docs/components/connectors/img/connector-asana.png
  • docs/components/connectors/img/connector-automation.png
  • docs/components/connectors/img/connector-aws-dynamodb.png
  • docs/components/connectors/img/connector-aws-lambda.png
  • docs/components/connectors/img/connector-azure-openai.png
  • docs/components/connectors/img/connector-blueprism.png
  • docs/components/connectors/img/connector-box.png
  • docs/components/connectors/img/connector-camunda.png
  • docs/components/connectors/img/connector-easypost.png
  • docs/components/connectors/img/connector-email.png
  • docs/components/connectors/img/connector-github.png
  • docs/components/connectors/img/connector-gitlab.png
  • docs/components/connectors/img/connector-google-drive.png
  • docs/components/connectors/img/connector-google-maps.png
  • docs/components/connectors/img/connector-google-sheets.png
  • docs/components/connectors/img/connector-graphql.png
  • docs/components/connectors/img/connector-hugging-face.png
  • docs/components/connectors/img/connector-kafka.png
  • docs/components/connectors/img/connector-openai.png
  • docs/components/connectors/img/connector-overview.png
  • docs/components/connectors/img/connector-rabbitmq.png
  • docs/components/connectors/img/connector-rest.png
  • docs/components/connectors/img/connector-salesforce.png
  • docs/components/connectors/img/connector-sendgrid.png
  • docs/components/connectors/img/connector-slack.png
  • docs/components/connectors/img/connector-soap.png
  • docs/components/connectors/img/connector-sql.png
  • docs/components/connectors/img/connector-teams.png
  • docs/components/connectors/img/connector-twilio.png
  • docs/components/connectors/img/connector-uipath.png
  • docs/components/connectors/img/connector-webhook.png
  • docs/components/connectors/img/connector-whatsapp.png
  • docs/components/connectors/img/icon-connector-custom.png
  • docs/components/connectors/img/icon-connector-generate.png
  • docs/components/connectors/img/icon-connector-manage.png
  • docs/components/connectors/img/icon-connector-sdk.png
  • docs/components/connectors/img/icon-connector-template.png
  • docs/components/connectors/img/icon-connector-types.png
  • docs/components/connectors/img/icon-connectors.png
  • docs/components/connectors/img/icon-marketplace.png
  • docs/components/connectors/img/icon-play.png
  • docs/components/connectors/introduction.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-bedrock.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-comprehend.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-dynamodb.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-eventbridge.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-s3.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-sagemaker.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-sns.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-sqs.md
  • docs/components/connectors/out-of-the-box-connectors/amazon-textract.md
  • docs/components/connectors/out-of-the-box-connectors/asana.md
  • docs/components/connectors/out-of-the-box-connectors/automation-anywhere.md
  • docs/components/connectors/out-of-the-box-connectors/available-connectors-overview.md
  • docs/components/connectors/out-of-the-box-connectors/aws-lambda.md
  • docs/components/connectors/out-of-the-box-connectors/azure-open-ai.md
  • docs/components/connectors/out-of-the-box-connectors/blueprism.md
  • docs/components/connectors/out-of-the-box-connectors/box.md
  • docs/components/connectors/out-of-the-box-connectors/easy-post.md
  • docs/components/connectors/out-of-the-box-connectors/email.md
  • docs/components/connectors/out-of-the-box-connectors/github.md
  • docs/components/connectors/out-of-the-box-connectors/gitlab.md
  • docs/components/connectors/out-of-the-box-connectors/google-gemini.md
  • docs/components/connectors/out-of-the-box-connectors/google-maps-platform.md
  • docs/components/connectors/out-of-the-box-connectors/google-sheets.md
  • docs/components/connectors/out-of-the-box-connectors/googledrive.md
  • docs/components/connectors/out-of-the-box-connectors/hugging-face.md
  • docs/components/connectors/out-of-the-box-connectors/kafka.md
  • docs/components/connectors/out-of-the-box-connectors/microsoft-o365-mail.md
  • docs/components/connectors/out-of-the-box-connectors/microsoft-teams.md
  • docs/components/connectors/out-of-the-box-connectors/openai.md
  • docs/components/connectors/out-of-the-box-connectors/operate.md
  • docs/components/connectors/out-of-the-box-connectors/rabbitmq-outbound.md
  • docs/components/connectors/out-of-the-box-connectors/salesforce.md
  • docs/components/connectors/out-of-the-box-connectors/sendgrid.md
  • docs/components/connectors/out-of-the-box-connectors/slack.md
  • docs/components/connectors/out-of-the-box-connectors/sql.md
  • docs/components/connectors/out-of-the-box-connectors/twilio.md
  • docs/components/connectors/out-of-the-box-connectors/uipath.md
  • docs/components/connectors/out-of-the-box-connectors/whatsapp.md
  • docs/components/connectors/protocol/graphql.md
  • docs/components/connectors/protocol/http-webhook.md
  • docs/components/connectors/protocol/polling.md
  • docs/components/connectors/protocol/rest.md
  • docs/components/connectors/protocol/soap.md
  • docs/components/connectors/react-components/_banner-marketplace.md
  • docs/components/connectors/react-components/_connectors-table.css
  • docs/components/connectors/react-components/_connectors-table.js
  • docs/components/connectors/react-components/icon-marketplace.png
  • docs/components/connectors/use-connectors/inbound.md
  • docs/components/connectors/use-connectors/index.md
  • docs/components/connectors/use-connectors/outbound.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@github-actions github-actions bot temporarily deployed to camunda-docs January 6, 2025 15:48 Destroyed
@YanaSegal
Copy link
Contributor

@mesellings this looks great! i really like the new structure! super useful, thank you!
let me know how can I help :)
looking forward to wave 2/3.

@sbuettner
Copy link
Contributor

sbuettner commented Jan 13, 2025

@mesellings Everyone who looked at this was at awe and I havent heard about anything worth correcting.

Thank you so much and lets get this merged!

Things that we have to watch from my perspective without any urgence:

  • Is the featured Connector part used by customers
  • How much effort will it take the team to manage the items

@github-actions github-actions bot temporarily deployed to camunda-docs January 17, 2025 11:27 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs January 17, 2025 11:44 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs January 17, 2025 12:02 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs January 17, 2025 12:14 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs January 17, 2025 13:25 Destroyed
Comment on lines +492 to +493
? "badge--medium"
: "badge--default"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[prettier] reported by reviewdog 🐶

Suggested change
? "badge--medium"
: "badge--default"
? "badge--medium"
: "badge--default"

@mesellings mesellings marked this pull request as ready for review January 17, 2025 15:27
@github-actions github-actions bot temporarily deployed to camunda-docs January 17, 2025 15:29 Destroyed
Copy link
Contributor

The preview environment relating to the commit 0956ddd has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4794/index.html

@mesellings
Copy link
Contributor Author

@sbuettner This PR for the first wave of connectors work is now ready for review and merge 👍

@pepopowitz as requested, I've tagged you in for a review of the react component work on Camunda connectors

Reviews should only concentrate on the restructure and main pages, as most other pages are untouched and will be covered in waves 2 and 3:

Note: I haven't changed any file locations, so no redirects are required.

@conceptualshark conceptualshark mentioned this pull request Jan 17, 2025
9 tasks
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is basically an inspiration at this point -- amazing work getting this all together! I find it incredibly easy to navigate with this structure, and I love the cleanup of the titles as a quick win while you're in here. The connectors table especially is a nice upgrade.

I am sure others will have reviews more relevant to their areas of expertise, but from an organizational and basic information perspective, no notes from me!

Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First off, this looks world class and I'm so thankful for you @mesellings and bringing this amazing experience to the Connectors team. They truly deserve it. 🧡

Comment: I thought the "Find a Camunda Connector" button would take me to the Camunda Marketplace, but I see that's another button.

Similar to my brand police comment on your dark mode PR, please ensure that you are following brand guidelines for the additional colors of labels and buttons (outbound and inbound labels prompted my brain to write this). This could be blocking.

Question: For the latest/popular content, who will commit to maintaining/updating that moving forward? I usually shy away from highlights like this because they can go stale.

Question: Did you mean to have a bolded link here?
image

Based on the other page, I assumed this would be a button.

Question: Is the > in the "Find a Camunda Connector >" button intentional? When do you add it and when do you not (the Marketplace button doesn't have a >, but pops you out of the docs).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:connectors Issues related to the connectors project. component:docs Documentation improvements, including new or updated content deploy Stand up a temporary docs site with this PR hold This issue is parked, do not merge. kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) target:8.7 Issues included in the 8.7 release
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

5 participants